HPD Retrieval API
Sample Response in Fhir-like Bundle Format
{
"hasMoreResults": false,
"fhirBundles": [{
"resourceType": "Bundle",
"id": "2e6522d4-8c7b-47eb-8c78-252b8ec801eb",
"meta": {
"lastUpdated": "2023-10-15T20:12:58.8845703+00:00"
},
"type": "searchset",
"timestamp": "2023-10-15T20:12:58.8845703+00:00",
"entry": [
{
"resource": {
"resourceType": "PractitionerRole",
"id": "R00000226-R",
"meta": {
"versionId": "0",
"lastUpdated": "2023-10-10T14:07:04.1358152+00:00",
"profile": [
"https://smex12-5-en-ctp.trendmicro.com:443/wis/clicktime/v1/query?url=http%3a%2f%2fhl7.org.nz%2ffhir%2fStructureDefinition%2fHPIPractitionerRole&umid=e5e6716a-e83a-4335-a978-cf3f90925c25&auth=ae5df323da80597a92aaa0a8b5168c30a6db536c-322fee8797c496b03aa9847049915d9999201a1c"
],
"security": [
{
"system": "https://smex12-5-en-ctp.trendmicro.com:443/wis/clicktime/v1/query?url=http%3a%2f%2fterminology.hl7.org%2fCodeSystem%2fv3%2dConfidentiality&umid=e5e6716a-e83a-4335-a978-cf3f90925c25&auth=ae5df323da80597a92aaa0a8b5168c30a6db536c-9287409dd35cabad0b653c87059ee512384406b1",
"code": "M"
}
]
},
"extension": [
{
"extension": [
{
"url": "organization",
"valueReference": {
"reference": "Organization/G08270-H"
}
},
{
"url": "person",
"valueReference": {
"reference": "HPD-User/Josh Jones (56)"
}
}
],
"url": "https://smex12-5-en-ctp.trendmicro.com:443/wis/clicktime/v1/query?url=http%3a%2f%2fhl7.org.nz%2ffhir%2fStructureDefinition%2fpractitionerRole%2dcreator&umid=e5e6716a-e83a-4335-a978-cf3f90925c25&auth=ae5df323da80597a92aaa0a8b5168c30a6db536c-852a6b60dc692c6c4bd3eb13d3d353dce454ab1a"
},
{
"url": "http://hpd/fhir/StructureDefinition/practitionerRole-source-system",
"valueString": "G08270-H-HPD"
}
],
"identifier": [
{
"use": "official",
"system": "https://smex12-5-en-ctp.trendmicro.com:443/wis/clicktime/v1/query?url=https%3a%2f%2fstandards.digital.health.nz%2fns%2fhpi%2dpractitionerrole%2did&umid=b8275f4e-668a-4d39-bf6b-f1b1274be202&auth=4208f9d292d4bb72367c9cdb6e8d9affc9f9dfab-aa60dda408aaa07d669d2070af2dbf9b69ba983d",
"value": "R00000226-R",
"assigner": {
"reference": "Organization/G00001-G"
}
},
{
"use": "secondary",
"system": "http://hpd/fhir/StructureDefinition/source-record-id",
"value": "HPDR000000069",
"assigner": {
"reference": "Organization/G08270-H"
}
}
],
"active": true,
"period": {
"start": "2023-10-01"
},
"practitioner": {
"reference": "Practitioner/95ZZHW"
},
"organization": {
"reference": "Organization/G00002-J"
},
"code": [
{
"coding": [
{
"system": "https://smex12-5-en-ctp.trendmicro.com:443/wis/clicktime/v1/query?url=http%3a%2f%2fsnomed.info%2fsct%2f223366009&umid=e5e6716a-e83a-4335-a978-cf3f90925c25&auth=ae5df323da80597a92aaa0a8b5168c30a6db536c-ccb09058c23e967bfc2884823b28fe072a1a17e5",
"version": "20190131",
"code": "309388007",
"display": "Vascular surgeon"
}
],
"text": "Vascular surgeon"
}
]
}
},
{
"resource": {
"resourceType": "Practitioner",
"id": "95ZZHW",
"meta": {
"versionId": "13044",
"lastUpdated": "2023-07-31T15:31:08+12:00",
"profile": [
"https://smex12-5-en-ctp.trendmicro.com:443/wis/clicktime/v1/query?url=http%3a%2f%2fhl7.org.nz%2ffhir%2fStructureDefinition%2fHPIPractitioner&umid=e5e6716a-e83a-4335-a978-cf3f90925c25&auth=ae5df323da80597a92aaa0a8b5168c30a6db536c-fa04131c941ea6a56ba58ae87533ec47c733d0f0"
],
"security": [
{
"system": "https://smex12-5-en-ctp.trendmicro.com:443/wis/clicktime/v1/query?url=http%3a%2f%2fterminology.hl7.org%2fCodeSystem%2fv3%2dConfidentiality&umid=e5e6716a-e83a-4335-a978-cf3f90925c25&auth=ae5df323da80597a92aaa0a8b5168c30a6db536c-9287409dd35cabad0b653c87059ee512384406b1",
"code": "L"
}
]
},
"extension": [
{
"extension": [
{
"url": "fullname",
"valueString": "Bpharm"
},
{
"url": "year",
"valueDate": "1998"
},
{
"url": "institution",
"valueString": "Otago Univeristy"
},
{
"url": "city",
"valueString": "DUNEDIN"
},
{
"url": "country",
"valueString": "NZ"
}
],
"url": "https://smex12-5-en-ctp.trendmicro.com:443/wis/clicktime/v1/query?url=http%3a%2f%2fhl7.org.nz%2ffhir%2fStructureDefinition%2feducational%2dqualification&umid=e5e6716a-e83a-4335-a978-cf3f90925c25&auth=ae5df323da80597a92aaa0a8b5168c30a6db536c-3b9c4016ceae3850e1a0091b5d4bd56c446dcce0"
}
],
"identifier": [
{
"use": "official",
"system": "https://smex12-5-en-ctp.trendmicro.com:443/wis/clicktime/v1/query?url=https%3a%2f%2fstandards.digital.health.nz%2fns%2fhpi%2dperson%2did&umid=b8275f4e-668a-4d39-bf6b-f1b1274be202&auth=4208f9d292d4bb72367c9cdb6e8d9affc9f9dfab-2934c9841a6a1a7d595c9bc5d7fb0d425facc8ce",
"value": "95ZZHW",
"assigner": {
"reference": "Organization/G00001-G"
}
},
{
"use": "official",
"system": "https://smex12-5-en-ctp.trendmicro.com:443/wis/clicktime/v1/query?url=https%3a%2f%2fstandards.digital.health.nz%2fns%2fpharmacy%2dcouncil%2did&umid=b8275f4e-668a-4d39-bf6b-f1b1274be202&auth=4208f9d292d4bb72367c9cdb6e8d9affc9f9dfab-466746d0023ea60721fdd2befc1e367f8064e339",
"value": "9946",
"assigner": {
"reference": "Organization/G00010-H"
}
}
],
"name": [
{
"use": "official",
"family": "Stark",
"given": [
"Ayra"
]
}
],
"qualification": [
{
"extension": [
{
"extension": [
{
"url": "status",
"valueCodeableConcept": {
"coding": [
{
"system": "https://smex12-5-en-ctp.trendmicro.com:443/wis/clicktime/v1/query?url=https%3a%2f%2fstandards.digital.health.nz%2fns%2fpractitioner%2dregistration%2dstatus%2dcode&umid=b8275f4e-668a-4d39-bf6b-f1b1274be202&auth=4208f9d292d4bb72367c9cdb6e8d9affc9f9dfab-d021e00394ffce7b6026f02d87e8ebc883020184",
"version": "2.0",
"code": "current",
"display": "A provider who holds or is deemed to hold a current practising certificate."
}
],
"text": "A provider who holds or is deemed to hold a current practising certificate."
}
},
{
"url": "period",
"valuePeriod": {
"start": "2019-03-13",
"end": "2120-02-13"
}
}
],
"url": "https://smex12-5-en-ctp.trendmicro.com:443/wis/clicktime/v1/query?url=http%3a%2f%2fhl7.org.nz%2ffhir%2fStructureDefinition%2fregistration%2dstatus%2dcode&umid=b8275f4e-668a-4d39-bf6b-f1b1274be202&auth=4208f9d292d4bb72367c9cdb6e8d9affc9f9dfab-163ea30c0a0dffeb8054fe2eb797656db38f959c"
},
{
"extension": [
{
"url": "code",
"valueCodeableConcept": {
"coding": [
{
"system": "https://smex12-5-en-ctp.trendmicro.com:443/wis/clicktime/v1/query?url=https%3a%2f%2fstandards.digital.health.nz%2fns%2fpractitioner%2dscope%2dof%2dpractice%2dcode&umid=b8275f4e-668a-4d39-bf6b-f1b1274be202&auth=4208f9d292d4bb72367c9cdb6e8d9affc9f9dfab-b264fbba0ee5e87be1c4c679cbf132e13b9e98d0",
"version": "1.0.0",
"code": "PHAR",
"display": "Pharmacist"
}
],
"text": "Pharmacist"
}
},
{
"url": "period",
"valuePeriod": {
"start": "1998-02-18",
"end": "2029-04-14"
}
}
],
"url": "https://smex12-5-en-ctp.trendmicro.com:443/wis/clicktime/v1/query?url=http%3a%2f%2fhl7.org.nz%2ffhir%2fStructureDefinition%2fscope%2dof%2dpractice&umid=e5e6716a-e83a-4335-a978-cf3f90925c25&auth=ae5df323da80597a92aaa0a8b5168c30a6db536c-905e25892c8e94e57edd0b24ca1a5b155b0f9fa2"
},
{
"url": "https://smex12-5-en-ctp.trendmicro.com:443/wis/clicktime/v1/query?url=http%3a%2f%2fhl7.org.nz%2ffhir%2fStructureDefinition%2fregistration%2dinitial%2ddate&umid=b8275f4e-668a-4d39-bf6b-f1b1274be202&auth=4208f9d292d4bb72367c9cdb6e8d9affc9f9dfab-b067654cfe230645164113cd4f6505531b246933",
"valueDate": "2018-02-04"
}
],
"identifier": [
{
"use": "official",
"system": "https://smex12-5-en-ctp.trendmicro.com:443/wis/clicktime/v1/query?url=https%3a%2f%2fstandards.digital.health.nz%2fns%2fpharmacy%2dcouncil%2did&umid=b8275f4e-668a-4d39-bf6b-f1b1274be202&auth=4208f9d292d4bb72367c9cdb6e8d9affc9f9dfab-466746d0023ea60721fdd2befc1e367f8064e339",
"value": "9946",
"assigner": {
"reference": "Organization/G00010-H"
}
}
],
"code": {
"coding": [
{
"system": "https://smex12-5-en-ctp.trendmicro.com:443/wis/clicktime/v1/query?url=https%3a%2f%2fstandards.digital.health.nz%2fns%2fpractitioner%2dregistration%2dauthority%2dcode&umid=b8275f4e-668a-4d39-bf6b-f1b1274be202&auth=4208f9d292d4bb72367c9cdb6e8d9affc9f9dfab-f5cd7f5983fd6a0178dd96ff849a5805afddfe39",
"version": "2.0",
"code": "PM",
"display": "Pharmacy Council of New Zealand Register"
}
],
"text": "Pharmacy Council of New Zealand Register"
},
"period": {
"start": "2019-03-13",
"end": "2120-02-13"
},
"issuer": {
"reference": "Organization/G00010-H"
}
}
],
"communication": [
{
"coding": [
{
"system": "urn:iso:std:iso:639:-3",
"version": "2007",
"code": "eng",
"display": "English"
}
],
"text": "English"
}
]
}
},
{
"resource": {
"resourceType": "Organization",
"id": "G00002-J",
"meta": {
"versionId": "7969",
"lastUpdated": "2022-04-05T15:01:37+12:00",
"profile": [
"https://smex12-5-en-ctp.trendmicro.com:443/wis/clicktime/v1/query?url=http%3a%2f%2fhl7.org.nz%2ffhir%2fStructureDefinition%2fHPIOrganization&umid=e5e6716a-e83a-4335-a978-cf3f90925c25&auth=ae5df323da80597a92aaa0a8b5168c30a6db536c-a10df1f53f0979b52a306cdcfdcb4cbc37435454"
]
},
"extension": [
{
"url": "https://smex12-5-en-ctp.trendmicro.com:443/wis/clicktime/v1/query?url=http%3a%2f%2fhl7.org.nz%2ffhir%2fStructureDefinition%2festablished&umid=e5e6716a-e83a-4335-a978-cf3f90925c25&auth=ae5df323da80597a92aaa0a8b5168c30a6db536c-a2363e3f788bc8fd7ab0dc14ffacd3ab9b4e94f3",
"valuePeriod": {
"start": "1991-03-02"
}
}
],
"identifier": [
{
"use": "official",
"system": "https://smex12-5-en-ctp.trendmicro.com:443/wis/clicktime/v1/query?url=https%3a%2f%2fstandards.digital.health.nz%2fns%2fhpi%2dorganisation%2did&umid=b8275f4e-668a-4d39-bf6b-f1b1274be202&auth=4208f9d292d4bb72367c9cdb6e8d9affc9f9dfab-c75678dc49aed2d1ad8f9101fe96f4ae9bd35de5",
"value": "G00002-J",
"assigner": {
"reference": "Organization/G00001-G"
}
}
],
"active": true,
"type": [
{
"coding": [
{
"system": "https://smex12-5-en-ctp.trendmicro.com:443/wis/clicktime/v1/query?url=https%3a%2f%2fstandards.digital.health.nz%2fns%2forganisation%2dtype%2dcode&umid=b8275f4e-668a-4d39-bf6b-f1b1274be202&auth=4208f9d292d4bb72367c9cdb6e8d9affc9f9dfab-ff81fa765691b7bb12a95c389c081b113f6d3209",
"version": "1.1",
"code": "999",
"display": "Other"
}
]
}
],
"name": "Dental Council of New Zealand",
"alias": [
"Dental Council of New Zealand"
],
"_alias": [
{
"extension": [
{
"url": "https://smex12-5-en-ctp.trendmicro.com:443/wis/clicktime/v1/query?url=http%3a%2f%2fhl7.org.nz%2ffhir%2fStructureDefinition%2falias%2dtype&umid=e5e6716a-e83a-4335-a978-cf3f90925c25&auth=ae5df323da80597a92aaa0a8b5168c30a6db536c-636bed4e0fa20279d14c0582006571595038ebc8",
"valueCodeableConcept": {
"coding": [
{
"system": "https://smex12-5-en-ctp.trendmicro.com:443/wis/clicktime/v1/query?url=https%3a%2f%2fstandards.digital.health.nz%2fns%2falias%2dtype%2dcode&umid=b8275f4e-668a-4d39-bf6b-f1b1274be202&auth=4208f9d292d4bb72367c9cdb6e8d9affc9f9dfab-22a54870c981e1270a6333648af380a2bb861041",
"version": "1.0.0",
"code": "legal",
"display": "Legal"
}
],
"text": "Legal"
}
}
]
}
],
"telecom": [
{
"system": "email",
"value": "updgrade@email.co.nz",
"use": "work",
"rank": 1,
"period": {
"start": "2015-05-05"
}
},
{
"system": "phone",
"value": "21 2546123",
"use": "work",
"rank": 2
}
]
}
}
]
}
],
"jsonResults": [],
"fhirResults": []
}